Add Plotly Dash support #4605

jonmmease · 2020-09-11T16:16:33Z

This PR adds support for displaying dynamic HoloViews objects using Plotly Dash.

The new logic is localized to the single holoviews/plotting/plotly/dash.py file which provides a new holoviews_to_dash function.

A new section has been added to all of the dynamic Plotly reference guide notebooks that includes the code for displaying the example in a Dash app. This is a good place to look at the example usage for the holoviews_to_dash function.

This PR is dependent on some of the fixes in #4572, and so it should be rebased on master after #4572 is merged.

jonmmease · 2020-09-29T13:33:46Z

pytest.ini

@@ -0,0 +1,2 @@
+[pytest]
+addopts = -p no:dash


This was added to disable the dash pytest plugin, which was causing this error (https://travis-ci.org/github/holoviz/holoviews/jobs/731249907):

pluggy.manager.PluginValidationError: Plugin 'dash' could not be loaded: (dash-table 4.4.1 (/home/travis/miniconda/envs/test-environment/lib/python2.7/site-packages), Requirement.parse('dash-table==4.10.1'))!

Would it be better to add dash-table to the testing envt so that the plugin doesn't have to be disabled?

I did try that, but the version on the main anaconda channel is too old (4.4.1). We'd have to pull 4.10.* from conda-forge, and it doesn't look like any packages are pulled from conda-forge right now.

jonmmease · 2020-09-29T13:35:45Z

I rebased on master and this PR is ready for review.

jlstevens · 2020-09-29T14:59:40Z

examples/reference/containers/plotly/DynamicMap.ipynb

+   ],
+   "metadata": {
+    "collapsed": false,
+    "pycharm": {


Wonder if this metadata is why GitHub isn't able to preview these notebooks? I recommend just clearing it out...

Yeah, good point. I'll clear it out if we decide to keep these notebook changes

jlstevens · 2020-09-29T15:00:38Z

Looks great!

Not much to say other than I would consider naming holoviews_to_dash to simply to_dash - anything imported from holoviews is implicitly about holoviews already :-)

jbednar

Looks great! I have a few small suggestions, and generally a wish for consolidating the Dash examples to avoid bloating the Reference gallery (see comments), but it will be great to have Dash support!

I think I've seen a demo of Dash supporting other libraries like Matplotlib and Bokeh, though I don't know how solid that was. I wonder if the mpl backend for HoloViews could be supported with Dash fairly easily, because it wouldn't need to be very ambitious (just displaying an image). Bokeh would be more tricky, I assume.

jbednar · 2020-09-29T19:25:06Z

examples/reference/containers/plotly/DynamicMap.ipynb

+    "import dash_html_components as html\n",
+    "\n",
+    "# Create App\n",
+    "external_stylesheets = ['https://codepen.io/chriddyp/pen/bWLwgP.css']\n",


It would be good to avoid depending on code in anyone's personal accounts; does it really need the .css decoration? Or could the file be moved somewhere more permanent?

Ahh, yeah, I'll pull that out if we keep the examples in these notebooks.

jbednar · 2020-09-29T19:28:15Z

examples/reference/streams/plotly/Bounds.ipynb

+    "app.layout = html.Div(\n",
+    "    [components.graphs[0], components.resets[0], components.store]\n",


I don't suppose there's a way to eliminate this step? Is it not appropriate for to_dash to modify app to do that already, at least as a default (with the default overridden in some examples that need special widgets)?

Overall, this is a lot of code to be adding to each of the examples, when most of it seems boilerplate. Can we not instead just make a single page in the user guide that shows one Panel example, one Voila example, and one Dash example (plus the caveat that Dash will only work for the Plotly backend), and then have all the reference notebooks (for all backends) link back to that page? That seems easier for us to maintain plus throws less code at the user to try to follow (assuming any given user will click on many of these pages).

I don't suppose there's a way to eliminate this step? Is it not appropriate for to_dash to modify app to do that already, at least as a default (with the default overridden in some examples that need special widgets)?

I don't think so, the idea is that user should place them in the layout of a larger Dash app that includes other Dash components.

I'll make some comments about the docs down below

jbednar · 2020-09-29T19:37:20Z

pytest.ini

@@ -0,0 +1,2 @@
+[pytest]
+addopts = -p no:dash


Would it be better to add dash-table to the testing envt so that the plugin doesn't have to be disabled?

holoviews/plotting/plotly/dash.py

jbednar · 2020-09-29T19:41:23Z

holoviews/plotting/plotly/dash.py

+                if panel_prop == "selected_data":
+                    if graph_id + ".selectedData" in triggered_prop_ids:
+                        # Only update selectedData values that just changed.
+                        # This way we don't the the may have been cleared in the


jonmmease · 2020-09-29T21:54:17Z

Not much to say other than I would consider naming holoviews_to_dash to simply to_dash

Sure, works for me

Co-authored-by: James A. Bednar <[email protected]>

jonmmease · 2020-09-29T22:14:21Z

Regarding the documentation. I'm currently working on a documentation page that will be added to the main Dash docs with a structure similar to https://dash.plotly.com/layout. I've waffled on this a little bit, but I'm currently leaning towards including Dash versions of these 6 interactive Plotly examples in that documentation page. The nice thing about having them there is that they will be fully interactive in the documentation.

So the simplest path forward may be for me to revert the notebook changes in this PR, then after the Dash documentation is published (which will require these changes to be released in HoloViews), add links from these pages to the corresponding example in the Dash docs.

How does that sound? The shared Panel/Voila/Dash page makes sense, but I guess I'm not volunteering to write it for this PR 🙃

jlstevens · 2020-09-30T09:10:22Z

Linking to plotly docs from the reference notebooks seems reasonable to me. My other suggestion is that instead of putting code into those notebooks and only having links, a section could be added to the Plotting with Plotly user guide but unfortunately it looks there was a problem with doc building :-(

A shared Panel/Voila/Dash user guide section would also be nice, but I am only proposing a dash example of the sort you added to the reference notebooks.

jonmmease · 2020-09-30T09:15:52Z

Linking to plotly docs from the reference notebooks seems reasonable to me.

Ok, I'll go ahead and revert the notebook changes from this PR and then come back to it after the Dash docs are up.

... Plotting with Plotly ...

Looks like there isn't an rst file for Plotting with Plotly

Do you think this existed at one point? Or maybe was never written?

We'll add references to corresponding sections in the Dash docs when those are live

…upport

jlstevens · 2020-09-30T09:20:50Z

Do you think this existed at one point? Or maybe was never written?

Good question! As far as I remember, those .rst files need to be explicitly added and I see no reason why such a file would ever have been removed. Could you add one for plotly in this PR? Following the Bokeh example, it should just be:

Plotting with Plotly
____________________

.. notebook:: holoviews ../../examples/user_guide/Plotting_with_Plotly.ipynb
    :offset: 1

If you decide to update that notebook, we'll then run a doc build to preview the changes.

jonmmease · 2020-09-30T09:29:56Z

Updates

holoviews_to_dash renamed to to_dash in dd373a9
Notebook changes reverted in 59a9381. I'll add links to Dash docs once they are live.

Could you add one for plotly in this PR? Following the Bokeh example, it should just be ...

Looks like a target Plotting_with_Plotly.ipynb notebook was never written. This was raised in #3949. I should write this soon, but I don't think it will be in this PR.

jonmmease · 2020-09-30T09:32:14Z

setup.py

@@ -67,7 +68,7 @@
    'mock',
    'flake8 ==3.6.0',
    'coveralls',
-    'path.py', 
+    'path.py',


whoops, my editor 🔪 the trailing whitespace here automatically, I can revert if anyone cares that it's not related to this PR.

philippjfr · 2020-09-30T11:55:02Z

That's right, a Plotting_with_Plotly guide was never actually written.

…mponents This can be used directly in `html.Div()` if no additional layout structure is needed

nicolaskruchten · 2020-10-08T12:43:49Z

holoviews/plotting/plotly/dash.py

+        slider_label_id = kdim_name + "-label-" + slider_uuid
+        kdim_uuids.append(slider_uuid)
+
+        html_lable = html.Label(id=slider_label_id, children=kdim_label)


typo: html_lable ;)

Thanks! 772b9ed

jonmmease · 2020-11-04T14:48:08Z

@kcpevey, is this Ubuntu Python 3.6 build failure a known issue? I don't see any error messages related to the tests that I recognize. Thanks!

kcpevey · 2020-11-06T18:13:54Z

@jonmmease that is not a known failure. I thought perhaps it was a one-off thing so I reran the workflows and now there are 3 failures across different versions/architectures. Based on the error, I don't know what's causing that.

philippjfr · 2020-11-06T20:42:08Z

Trying to fix up those flakey tests now.

jonmmease · 2020-11-07T16:23:52Z

Thanks @philippjfr!

jonmmease marked this pull request as draft September 11, 2020 16:16

jonmmease mentioned this pull request Sep 14, 2020

Support widgets in link_selections #4609

Open

Add Plotly Dash support

72160d8

jonmmease force-pushed the dash_support branch from 5b76560 to 72160d8 Compare September 29, 2020 11:22

jonmmease added 2 commits September 29, 2020 07:55

Add Dash version constraints

0716d7e

Try disabling Dash pytest plugin with pytest.ini file

adefb5e

jonmmease commented Sep 29, 2020

View reviewed changes

jonmmease marked this pull request as ready for review September 29, 2020 13:33

jlstevens reviewed Sep 29, 2020

View reviewed changes

jbednar reviewed Sep 29, 2020

View reviewed changes

Update holoviews/plotting/plotly/dash.py

e538366

Co-authored-by: James A. Bednar <[email protected]>

jonmmease added 3 commits September 30, 2020 05:17

Rename holoviews_to_dash to to_dash

dd373a9

Revert notebook changes

59a9381

We'll add references to corresponding sections in the Dash docs when those are live

Merge branch 'dash_support' of github.com:pyviz/holoviews into dash_s…

c040952

…upport

jonmmease commented Sep 30, 2020

View reviewed changes

Add DashComponents.children property that holds a flat list of all co…

dfb1766

…mponents This can be used directly in `html.Div()` if no additional layout structure is needed

nicolaskruchten reviewed Oct 8, 2020

View reviewed changes

jonmmease added 2 commits October 9, 2020 05:22

fix lable -> label typos

772b9ed

Merge remote-tracking branch 'origin/master' into dash_support

7221f64

jonmmease added this to the v1.14.0 milestone Nov 4, 2020

Fix cleanup of Document

27460c5

philippjfr force-pushed the dash_support branch from 8f16dc0 to 27460c5 Compare November 7, 2020 14:58

philippjfr merged commit 87622b5 into master Nov 7, 2020

philippjfr deleted the dash_support branch April 25, 2022 14:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Plotly Dash support #4605

Add Plotly Dash support #4605

jonmmease commented Sep 11, 2020

jonmmease Sep 29, 2020

jbednar Sep 29, 2020

jonmmease Sep 29, 2020

jonmmease commented Sep 29, 2020

jlstevens Sep 29, 2020

jonmmease Sep 29, 2020

jlstevens commented Sep 29, 2020 •

edited

Loading

jbednar left a comment

jbednar Sep 29, 2020

jonmmease Sep 29, 2020

jbednar Sep 29, 2020

jonmmease Sep 29, 2020

jbednar Sep 29, 2020

jbednar Sep 29, 2020

jonmmease commented Sep 29, 2020

jonmmease commented Sep 29, 2020

jlstevens commented Sep 30, 2020 •

edited

Loading

jonmmease commented Sep 30, 2020

jlstevens commented Sep 30, 2020 •

edited

Loading

jonmmease commented Sep 30, 2020

jonmmease Sep 30, 2020

philippjfr commented Sep 30, 2020

nicolaskruchten Oct 8, 2020

jonmmease Oct 9, 2020

jonmmease commented Nov 4, 2020

kcpevey commented Nov 6, 2020

philippjfr commented Nov 6, 2020

jonmmease commented Nov 7, 2020

		"app.layout = html.Div(\n",
		" [components.graphs[0], components.resets[0], components.store]\n",

Add Plotly Dash support #4605

Add Plotly Dash support #4605

Conversation

jonmmease commented Sep 11, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jonmmease commented Sep 29, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jlstevens commented Sep 29, 2020 • edited Loading

jbednar left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jonmmease commented Sep 29, 2020

jonmmease commented Sep 29, 2020

jlstevens commented Sep 30, 2020 • edited Loading

jonmmease commented Sep 30, 2020

jlstevens commented Sep 30, 2020 • edited Loading

jonmmease commented Sep 30, 2020

Updates

Choose a reason for hiding this comment

philippjfr commented Sep 30, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jonmmease commented Nov 4, 2020

kcpevey commented Nov 6, 2020

philippjfr commented Nov 6, 2020

jonmmease commented Nov 7, 2020

jlstevens commented Sep 29, 2020 •

edited

Loading

jlstevens commented Sep 30, 2020 •

edited

Loading

jlstevens commented Sep 30, 2020 •

edited

Loading